home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / jmsts101.zip / JMSTATS.DOC < prev    next >
Text File  |  1992-11-22  |  39KB  |  991 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                   JMSTATS!
  7.                            for Wildcat! BBS systems
  8.  
  9.                            written by Joe Martin
  10.                                copyright 1992
  11.  
  12.  
  13.             JMSTATS is a complete analyzer of the  Activity logs that are
  14.        produced by Wildcat!. This one program will read the activity logs
  15.        created by either version 3.55 or 2.55 depending on the command line
  16.        you use and store that information for use in later displays.  If
  17.        you have tried to review your activity log file like I have, you
  18.        have probably found that it is great if you are looking at one
  19.        specific thing at a time, but useless if you are interested in
  20.        getting any kind of analysis of what is happening on the BBS on a
  21.        long term basis.  The activity log files take up a lot of room, and
  22.        with a single line or more for each activity, a very active person
  23.        can take up multiple screens of information in a single call.
  24.             Well, no more will you have to settle for this. JMSTATS will
  25.        read these activity logs and compile them into output files that can
  26.        be looked at and interpreted at a glance. This program has been
  27.        designed to be efficient and easily configurable by the sysop to
  28.        meet his needs.  Since each Wildcat!  BBS is distinctive, so should
  29.        the program that analyzes the BBS be.  No need to settle for a
  30.        predefined display that only gives you part of what you need.
  31.             This program was conceived by a need I had of trying to
  32.        determine what was happening on my board over a period of time. I
  33.        have incorporated as many features as I could think of and will add
  34.        more if there is a need.  Now, by looking at a couple of displays, a
  35.        sysop can get a really good feel of what is happening on their
  36.        board.
  37.  
  38.             JMSTATS is written in Turbo Pascal and is designed to be very
  39.        fast.  There is the capability of having multiple configuration
  40.        files so that the data can be collected and output in various
  41.        manners. I will try to go through all the ideas that I would like
  42.        this program to do as it progresses, and I am anxious to hear from
  43.        others whether it fits their needs or if there are some other things
  44.        that I can accomplish with the program. The final outcome of this
  45.        program will depend on what YOU, the sysops, would like to see it
  46.        become. I have added in everything I can think of, but I am sure
  47.        there are others with even better ideas.
  48.             That about covers the general scope and ideals of the program,
  49.        now I will get on to some of the features and uses of the program.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                       page 1
  65.  
  66.  
  67.  
  68.  
  69.                                       Jmstats
  70.  
  71.  
  72.                                  DISCLAIMER
  73.  
  74.            This software is provided without any guarantee, either
  75.        expressed or implied.  All responsibilities for its use rest with
  76.        the user of the software and not the author.
  77.  
  78.            JMSTATS software and this document are (C) Copyright 1992
  79.        by Joe Martin.  All rights reserved World Wide.
  80.  
  81.  
  82.                                       LICENSE
  83.  
  84.            JMSTATS is not in the Public Domain.  JMSTATS is not free.
  85.        Non-registered users are granted a limited, 30-day license to
  86.        determine whether or not the program meets their needs.  Continued
  87.        use of JMSTATS beyond the 30-day evaluation time period requires
  88.        registration of the program.  Use of non-registered copies of
  89.        JMSTATS beyond the original evaluation period is strictly
  90.        prohibited.  No one may modify JMSTATS for any reason, in any way,
  91.        including but not limited to decompiling-compiling, patching,
  92.        disassembling, or reverse engineering the program.  JMSTATS may be
  93.        copied and distributed to others, subject to the above restrictions
  94.        and the following:
  95.  
  96.              * JMSTATS must be copied in unmodified form, including the
  97.                file containing this license information.
  98.              * Complete JMSTATS documentation must be included.
  99.              * No copying fee of any type may be assessed other than basic
  100.                charges for the cost of the copying medium.
  101.              * JMSTATS may not be distributed with any other software or
  102.                hardware product(s) without the express written permission
  103.                of Joe Martin.
  104.  
  105.            Sysops (bulletin board SYStem OPerators) may make JMSTATS
  106.        available for downloading by their users as long as all above
  107.        conditions are met.
  108.  
  109.            Commercial Distributors of Public Domain, ShareWare, or User
  110.        Supported software may distribute JMSTATS subject to the above
  111.        conditions only after obtaining specific written permission from Joe
  112.        Martin and filling out a registration form for upgrade
  113.        notifications.  This condition supersedes any and all previous
  114.        agreements.
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                       page 2
  131.  
  132.  
  133.  
  134.  
  135.                                       Jmstats
  136.  
  137.  
  138.                                     FEATURES
  139.  
  140.  
  141.           Program operation is handled by using configuration files to set
  142.        up the program to fit the needs of your BBS.
  143.  
  144.           Multiple configuration files that allow you to display the data
  145.        differently or store it in different areas. These multiple
  146.        configuration files can be used to read the activity log files from
  147.        different nodes on a multi-node BBS. They can also be used to store
  148.        the data in different directories for providing different criteria
  149.        such as different length of time to keep the data. For example, you
  150.        may have a subdirectory called WEEKLY and one called MONTHLY and
  151.        each can store the data for the previous week or month. This way,
  152.        you can tell if things are changing on the board and where your
  153.        board is improving or lacking.
  154.  
  155.           Configuration of multiple baud rates to be used in the DOWNLOAD
  156.        display file. The configuration will accept up to 8 baud rates, but
  157.        4 is recommended if you plan on using this file for display on a BBS
  158.        or on your screen. You can choose the most popular baud rates on
  159.        your BBS, whether you have high speed modems or not.
  160.  
  161.           Configuration of multiple file transfer protocols to be used in
  162.        the DOWNLOAD display file. The configuration file will allow you to
  163.        enter up to 10 transfer protocols and will include all others not
  164.        entered in a general grouping called OTHER PROTOCOLS. If you are
  165.        using this file for display on a BBS or on a screen and wish to keep
  166.        it to a single screen, then I would recommend including only 5
  167.        transfer protocols and letting the rest be included in the OTHER
  168.        PROTOCOLS.
  169.  
  170.           Command line switch to not display MNP connections. This would be
  171.        very useful for those sysops who do not have an error-correcting
  172.        modem and thus would never have any use for display connections with
  173.        MNP.
  174.  
  175.           Configuration of Minimum and Maximum transfer CPS to prevent the
  176.        DOWNLOAD display from using erroneous figures in calculating the
  177.        average cps for a protocol or as the minimum or maximum cps in the
  178.        display.  These are entered as a percentage of the optimum transfer
  179.        rate. For example, at 2400 baud, the optimum as determined by most
  180.        terminal and BBS programs would be 240 cps. If you use a minimum
  181.        percentage of 50, the program will calculate the minimum cps to
  182.        accept as 50% of 240 cps which would be 120 cps. The same is true
  183.        for the maximum percentage. If you configure it for a maximum of
  184.        150, at 2400 baud it would be 150% of 240 which would be 360 cps.
  185.        Between these two figures, you can set the limits as to what is
  186.        included in the DOWNLOAD display file.
  187.  
  188.           Display file output can be automatically configured to go to the
  189.        screen by leaving the output path and filename as BLANK.  It can
  190.        also be directed to the printer by entering "PRN" as the output file
  191.        name. This can be very handy if you want to have one configuration
  192.        that includes all of your file transfer protocols or bauds and you
  193.        have a printer that can handle the size of the report.
  194.  
  195.  
  196.                                       page 3
  197.  
  198.  
  199.  
  200.  
  201.                                       Jmstats
  202.  
  203.  
  204.           Exclude files for certain routines to allow the sysop to exclude
  205.        certain file areas or security levels from showing up. This would
  206.        prevent a display from showing areas or filenames that some sysops
  207.        do not want displayed to the general caller, but may want to display
  208.        when he looks at it.
  209.  
  210.           A display file that shows the various activity levels by the
  211.        security level of the callers. This will let a sysop determine how
  212.        good or bad certain security levels are. For example, are your
  213.        callers with a visiting sysop security level spending more time
  214.        downloading files than your subscribing members?
  215.  
  216.           A display file showing various activities sorted by the hour of
  217.        the day. This display can be very useful in determining what is
  218.        being used most on your board during certain times of the day.
  219.  
  220.           There is also a Door Game usage display that will show the number
  221.        of times a door is entered, how much time has been spent in the door
  222.        and also the average time spent in the door. This display can be
  223.        sorted by any of the above fields.
  224.  
  225.           A file download history display that will allow you to enter a
  226.        filename and get a listing of everyone who has downloaded that
  227.        particular file. This is one of the best features of the program in
  228.        my judgement. A couple of uses for this would be to either notify
  229.        all users that have downloaded a particular file in the event you
  230.        found that the file was corrupted or had a virus in it or maybe to
  231.        get a listing of all the callers that have downloaded your
  232.        registration form.
  233.  
  234.           A caller display that will give you loads of pertinent
  235.        information about a particular caller. It will display the number of
  236.        calls, uploads, downloads, fast logins, pages and so on. In
  237.        addition, it will list the name of every file that person has
  238.        uploaded and also a list of every file that they have downloaded.
  239.        This way you can get a good, overall picture of what a particular
  240.        caller has been doing with their on-line time.
  241.  
  242.           Colors are being used by some of the displays and the actual
  243.        colors are stored in a separate file. This file can be set up using
  244.        either the WildCat! @ codes or can contain ANSI codes, whichever the
  245.        sysop prefers. I have included a sample DISPLAY.CLR file with the
  246.        program as an example. If you do not wish to use color codes, either
  247.        change the file or remove it.
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                       page 4
  263.  
  264.  
  265.  
  266.  
  267.                                       Jmstats
  268.  
  269.  
  270.                                    OPERATION
  271.  
  272.  
  273.             I would suggest creating a directory called something similar
  274.        to JMSTATS so that you can keep all the files together. Unzip this
  275.        file and put all of the files into this directory that were created
  276.        from the ZIP file.  Then, using a plain ASCII text editor, change
  277.        the JMSTAT.CFG file to match the setup needed for operation on your
  278.        board.  You can also copy this file over to other file names if you
  279.        need to have multiple configurations.  Then edit each one in turn
  280.        and modify it accordingly. I have included full explanation of what
  281.        each line in the config file should look like in the example config
  282.        (JMSTAT.CFG) that is included in this archive.
  283.             I have also included some sample output files (those with names
  284.        ending in .BBS and .CLR) for you to see what the displays will look
  285.        like.
  286.             This program can be run either by using switches on the command
  287.        line after the name of the program or by just keying in JMSTAT to
  288.        bring up a menu.  If you wish to use a configuration file other than
  289.        "JMSTAT.CFG", you must include it as the FIRST parameter after the
  290.        program name.  If the name of the configuration file is left off,
  291.        the system will automatically use the JMSTAT.CFG file. If the
  292.        configuration file is not found, the program will error out.
  293.             All other switches must be preceded by the '/' in order for the
  294.        program to read them. Some switches will have only one letter while
  295.        others can include other needed information immediately following
  296.        the '/'. A listing of the valid switches is as follows:
  297.  
  298.  
  299.        /A or /a .....This switch will create a display file of both your
  300.                 file areas and message areas and shows you how many times
  301.                 files have been downloaded from certain file areas and how
  302.                 many messages are left in certain message areas.  This file
  303.                 is automatically sorted by usage so it is easy to determine
  304.                 what areas of your board are the most popular. The current
  305.                 maximum is 1000 file areas and/or 1000 message areas.
  306.  
  307.  
  308.        /Ccallername or /ccallername .....This switch followed immediately
  309.                 by a caller's name will create a display file for an
  310.                 individual caller.  The program will locate the first
  311.                 caller that matches what you have entered, so you must
  312.                 include enough so that it will display the proper caller.
  313.                 If you need to include a space in the caller's name to
  314.                 narrow it down, this can be done by replacing the space
  315.                 with an underscore '_' character on the command line. The
  316.                 program will automatically convert this to a space. It will
  317.                 display the general stats for that caller including such
  318.                 things as number of calls, number of doors, time spent in
  319.                 doors, number of uploads, number and name of all files that
  320.                 this caller has uploaded and downloaded, plus many other
  321.                 statistics relating to that caller. What would you like to
  322.                 have included in this?
  323.  
  324.  
  325.        /Dno or /dno .....This switch tells the program to create the
  326.                 DOWNLOAD display file from the data already collected and
  327.  
  328.                                       page 5
  329.  
  330.  
  331.  
  332.  
  333.                                       Jmstats
  334.  
  335.  
  336.                 output it to what is set up in the config file. The 'no'
  337.                 part tells the program to not print any MNP lines. This is
  338.                 especially useful for those with non error-correcting
  339.                 modems and will allow for twice as many protocols on the
  340.                 screen.
  341.  
  342.  
  343.        /Ffilename or /ffilename .....This switch will produce a report of
  344.                 everyone who has downloaded a particular file and when.
  345.                 You must include the filename immediately following the /U.
  346.                 This can be particularly useful if for example you find out
  347.                 that one of your files contains a new virus that was not
  348.                 picked up during an initial virus scan. It will make it
  349.                 very simple to find out who has downloaded this file and
  350.                 notify them. Now that is what I would call a conscientious
  351.                 sysop.
  352.  
  353.  
  354.        /Gx or /gx .....This switch will produce a display of the door game
  355.                   statistics. It will include the door numbers, times
  356.                   entered, total and average time spent in each door game.
  357.                   This will help you in determining which doors are most
  358.                   popular and which may need to be removed due to lack of
  359.                   use. The current limit for # of doors is 29.
  360.                   The 'x' stands for an additional sort parameter. The
  361.                   options for x are as follows:
  362.  
  363.                 U or u...sort by times Used
  364.                 A or a...sort by average time in door
  365.                 T or t...sort by total time in door
  366.  
  367.  
  368.        /H or /h .....This switch will bring up a short listing of the
  369.                 command options that are available.
  370.  
  371.  
  372.        /Omm/dd/yy or /omm/dd/yy or /Onn or /onn .....This switch will
  373.                 reorganize the database files.  The JDM files must first be
  374.                 sorted using any text file sorting program you wish. I find
  375.                 that QSORT by Ben Baker to do these sorts extremely fast.
  376.                 This switch will remove any duplicate lines from the
  377.                 database files.  This will only need to be used if for some
  378.                 reason you read the same activity log more than one time,
  379.                 or if the database files get messed up with a bad date on
  380.                 the system or something like that.  Optionally, you will be
  381.                 able to include a date immediately following the switch and
  382.                 the system will remove all database entries prior to the
  383.                 date you enter. This is much better than deleting the
  384.                 entire file and starting over each month or so. This way,
  385.                 you can maintain a constant size for the databases. The
  386.                 date must be entered as a 2 digit month, a '/', a 2 digit
  387.                 date, a '/' and a 2 digit year. If the date you enter is
  388.                 not in a valid format, the program will notify you. You may
  389.                 also enter a single number such as '30' or '120' and the
  390.                 program will clear out all data entries older than this
  391.                 number of days.
  392.  
  393.  
  394.                                       page 6
  395.  
  396.  
  397.  
  398.  
  399.                                       Jmstats
  400.  
  401.  
  402.  
  403.        /Rxxx or /rxxx .....This tells the program to read the activity log
  404.                 file that you have set up in the config file and add the
  405.                 information into the database files.  That is all the
  406.                 program will do with that switch and will produce no output
  407.                 at that point. For those sysops who are using Tomcat! for
  408.                 NetMail and do not wish the messages uploaded by these
  409.                 netsysops to be included in your message information, you
  410.                 can exclude up to 20 security levels by putting them in a
  411.                 file called EXCLUDE.NET. This file should contain the exact
  412.                 security levels you do not wish to be included in the
  413.                 message statistics (including capitalization). The program
  414.                 will check for the existence of this file and will build
  415.                 all other statistics except the messages database for these
  416.                 callers. The optional field (xxx) will accept the value
  417.                 '255' and will then be able to read the activity logs
  418.                 created by WildCat! version 2.55. This currently has
  419.                 limited support because I have only had one activity log
  420.                 file to look at from that release.
  421.  
  422.  
  423.  
  424.        /Sxx or /sxx .....This switch tells the program to create the
  425.                 SECURITY display file from the data already collected and
  426.                 output it to what is set up in the config file. The current
  427.                 limit of # of security levels is 29. The xx part is
  428.                 optional and will determine the sorting of the security
  429.                 display file. xx may consist of the following:
  430.  
  431.                 DL or dl...sort by number of downloads
  432.                 UL or ul...sort by number of uploads
  433.                 FL or fl...sort by number of Fast Logins
  434.                 NF or nf...sort by number of New file scans
  435.                 TU or tu...sort by number of Tomcat Uploads
  436.                 TD or td...sort by number of Tomcat Downloads
  437.                 P  or p ...sort by number of sysop Pages
  438.                 M  or m ...sort by number of Messages
  439.                 G  or g ...sort by number of door Games entered
  440.                 TC or tc...sort by number of total calls
  441.                 AV or av...sort by Average time per call
  442.                 TM or tm...sort by Total Minutes
  443.  
  444.  
  445.                 There is also an additional feature of this display and
  446.                 that is the ability to EXCLUDE certain security levels from
  447.                 your display. To do this, create a file called EXCLUDE.SEC
  448.                 in the directory that you are running the JMSTATS program
  449.                 from. Each line of this file would be a security level
  450.                 exactly as it appears in your Activity log. This includes
  451.                 capital letters. Any security level found in this file will
  452.                 not be reported by the security display file. I have
  453.                 included an example of a EXCLUDE.SEC file you to see how it
  454.                 is set up.
  455.  
  456.  
  457.        /T or /t .....This switch tells the program to create the Time of
  458.                 Day display file. This is a complete display by the hour of
  459.  
  460.                                       page 7
  461.  
  462.  
  463.  
  464.  
  465.                                       Jmstats
  466.  
  467.  
  468.                 the day that will tell you what happened each hour. This
  469.                 includes # of calls, messages, doors, uploads, downloads,
  470.                 pages, etc. The output will be directed to what is set up
  471.                 in the Config file.
  472.  
  473.  
  474.        /TFexclude.fil or /tfexclude.fil .....This switch will produce a top
  475.                 45 download file listing. In addition, it will allow you
  476.                 the ability via an external EXCLUDE file to not print
  477.                 statistics for certain file areas.  This could be
  478.                 especially useful if you have Adult file areas on the board
  479.                 and do not wish to include them in your top files listing.
  480.                 The default file name that should contain the number of the
  481.                 file areas to exclude is EXCLUDE.FIL. A different filename
  482.                 can be specified on the command line in place of the
  483.                 exclude.fil file. The program currently allows up to 30
  484.                 file areas to be excluded by putting the file area numbers
  485.                 into the EXCLUDE.FIL using one file area per line. An
  486.                 example EXCLUDE.FIL is included in this package. Be sure to
  487.                 review it and either delete it or change it to fit the
  488.                 needs of your BBS.
  489.  
  490.  
  491.  
  492.             These switches may be combined on one command line and will be
  493.        performed in the order that they are entered.  Multiple switches can
  494.        and should be included on the command line. Below are some examples
  495.        of how to use this command line operation to achieve the desired
  496.        results.
  497.  
  498.  
  499.             Let's assume that you are running a single line Wildcat!  BBS
  500.        and wish to use only the DOWNLOAD display file as bulletin #1 on
  501.        your board. First, make sure you have the JMSTAT.CFG file set up to
  502.        match the paths and needs of your system. Let us also assume that
  503.        you will be running this program in your nightly event batch
  504.        program. This is the way you would use the program.
  505.  
  506.  
  507.        NIGHTLY.BAT
  508.  
  509.        CD \JMSTATS
  510.        JMSTAT JMSTAT.CFG /R /D
  511.  
  512.        (this could also be written as follows)
  513.        JMSTAT /R /D
  514.        (since the config file name of JMSTAT.CFG is the default)
  515.  
  516.             That is all that is needed to run on a single line system. If
  517.        you would also like to have it prepare the SECURITY display file,
  518.        but just keep it in the JMSTATS directory for your own use, then be
  519.        sure to set the path correctly in the config file and use the
  520.        following command.
  521.  
  522.        CD /JMSTATS
  523.        JMSTAT JMSTAT.CFG /R /D /S
  524.  
  525.  
  526.                                       page 8
  527.  
  528.  
  529.  
  530.  
  531.                                       Jmstats
  532.  
  533.  
  534.             The /r will build the database from your activity log file. The
  535.        /d will build the DOWNLOAD display file based on the information
  536.        calculated with the first /r switch. The /s switch will build the
  537.        SECURITY display file in a similar manner.
  538.  
  539.             WARNING!!! Use the /r switch only once on a given activity log
  540.        file or the program will add the same information into the file
  541.        multiple times. What this means is that you should delete the
  542.        activity log file or rename it once it has been read by this
  543.        program.
  544.  
  545.             For a multi line system that has more than one activity log but
  546.        the sysop wishes to include the data from all nodes into the
  547.        database files that the reports are built from, then you will have
  548.        to make separate config files for each node.  Since the config file
  549.        includes the full file name that it will read in to include, you
  550.        would have to have something like JMSTAT1.CFG to read in node 1,
  551.        JMSTAT2.CFG to read in node 2, and so on. Then, your nightly batch
  552.        file to read the data from both nodes and combine them into one
  553.        database and prepare both the DOWNLOAD and SECURITY files would look
  554.        like this:
  555.  
  556.        NIGHTLY.BAT
  557.  
  558.        CD \JMSTATS
  559.        JMSTAT JMSTAT1.CFG /R
  560.        JMSTAT JMSTAT2.CFG /R /D /S
  561.  
  562.  
  563.             The first time the program is called, it only reads the
  564.        information from the activity log for node 1 into the database. The
  565.        second time the program is called, it reads in the information from
  566.        the activity log for node 2, then it processes and creates the
  567.        DOWNLOAD and SECURITY display files. For more than 2 nodes, you
  568.        would just run the program once for each node using just the /r
  569.        switch but include the /d and /s switches when running the program
  570.        on the last node to be included.
  571.  
  572.  
  573.             To clear the database files, you would first use the /r switch
  574.        to read in the latest data. Then you would use a sorting program
  575.        like QSORT by Ben Baker or any other that you prefer, then use the
  576.        /o switch to clean up the database files. To clear out old records,
  577.        include a date or a number of days after the /o. Here is an example
  578.        of how this would work.
  579.  
  580.        CD \JMSTATS
  581.        JMSTAT JMSTAT.CFG /R
  582.        QSORT CALLS.JDM
  583.        QSORT MESSAGES.JDM
  584.        QSORT DOWNLOADS.JDM
  585.        QSORT UPLOADS.JDM
  586.        QSORT DOORS.JDM
  587.        JMSTAT JMSTAT.CFG /O11/01/92
  588.  
  589.  
  590.             This first reads in the new data, then the Qsort program sorts
  591.  
  592.                                       page 9
  593.  
  594.  
  595.  
  596.  
  597.                                       Jmstats
  598.  
  599.  
  600.        each of the database files, then the last line deletes any duplicate
  601.        lines and also removes any entries prior to Nov 1st, 1992.
  602.  
  603.             The file that is used to provide the color codes to the program
  604.        is called DISPLAY.CLR. If this file exists, the system will use it
  605.        to enhance the output display files. The format for it is fairly
  606.        simple. Lines 1 and 2 are used for the display heading. Line 3 is
  607.        used for all borders. Lines 4 through 9 are used as column headings
  608.        and the lines from 10 through 15 are used for the actual data. Line
  609.        16 is the code that is printed before the start of the display, and
  610.        can be used to clear the screen or do a nopause. Line 17 is an
  611.        ending code and could be used to pause the screen. Each line should
  612.        contain just one color code.  It could either be a Wildcat!  color
  613.        code or an ANSI color sequence, whichever you prefer.
  614.        There is a sample DISPLAY.CLR file included in this package, so if
  615.        you do not wish to use color, either delete or rename this file.
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.                                       page 10
  659.  
  660.  
  661.  
  662.  
  663.                                       Jmstats
  664.  
  665.  
  666.                                     SUPPORT
  667.  
  668.  
  669.             This program will be supported through ANDROID II BBS, where I
  670.        am the sysop.  The numbers for the BBS are (404) 978-6736 which is a
  671.        2400 baud line and (404) 978-9636 which is a 14,400 v.32bis modem.
  672.        Leave a message to Joe Martin in the JMSTATS support conference. If
  673.        you have an emergency problem, you can try paging the sysop. I am
  674.        also considering setting up a voice support line for registered
  675.        sysops, but that will have to wait until I can find out what kind of
  676.        impact the program will have.
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.                                       page 11
  725.  
  726.  
  727.  
  728.  
  729.                                       Jmstats
  730.  
  731.  
  732.                                  Database Files
  733.  
  734.  
  735.  
  736.                 For those that may find an interest or wish to write their
  737.        own reports from the databases built by JMSTATS, I am including a
  738.        detail summary of the layout of these files. These are the files
  739.        with the extension of JDM.
  740.  
  741.                                        CALLS
  742.  
  743.        position         description
  744.  
  745.        1 - 8         The date of the call.
  746.        9 - 13        The time of the call.
  747.        14 - 16       Amount of time spent on-line.
  748.        17            The type of exit the user made (normal, dropped, etc.)
  749.        18            Whether fast login was used.
  750.        19            Whether a new files scan was done.
  751.        20            Whether the caller uploaded replies using Tomcat!
  752.        21            Whether the caller downloaded messages using Tomcat!
  753.        22            Whether the caller paged the sysop.
  754.        23 - 42       Caller's name.
  755.        43 - 52       Caller's security level.
  756.  
  757.  
  758.                                       UPLOADS
  759.  
  760.        position         description
  761.  
  762.        1 - 8         The date of the call.
  763.        9 - 13        The time of the call.
  764.        14 - 18       Baud rate of the call.
  765.        19            Whether the connection was MNP.
  766.        20 - 31       The filename of the upload.
  767.        32 - 41       The protocol used to upload the file.
  768.        42 - 44       The file area that it was uploaded to.
  769.        45 - 64       Caller's name.
  770.        65 - 74       Caller's security level.
  771.  
  772.  
  773.                                      DOWNLOADS
  774.  
  775.        position         description
  776.  
  777.        1 - 8         The date of the call.
  778.        9 - 13        The time of the call.
  779.        14 - 18       The baud rat oe the call.
  780.        19            Whether the connection was MNP.
  781.        20 - 23       The CPS of the transfer.
  782.        24 - 35       The filename of the download.
  783.        36 - 45       The protocol used for the transfer.
  784.        46 - 48       The file area downloaded from.
  785.        49 - 68       Caller's name.
  786.        69 - 77       Caller's security level.
  787.  
  788.  
  789.  
  790.                                       page 12
  791.  
  792.  
  793.  
  794.  
  795.                                       Jmstats
  796.  
  797.  
  798.                                      MESSAGES
  799.  
  800.        position         description
  801.  
  802.        1 - 8         The date of the call.
  803.        9 - 13        The time of the call.
  804.        14 - 17       The message area the the message was entered in.
  805.        18 - 37       Caller's name.
  806.        38 - 47       Caller's security level.
  807.  
  808.  
  809.                                        DOORS
  810.  
  811.        position         description
  812.  
  813.        1 - 8         The date of the call.
  814.        9 - 13        The time of the call.
  815.        14 - 15       Amount of time spent in the door.
  816.        16 - 18       The door number.
  817.        19 - 38       Caller's name.
  818.        39 - 48       Caller's security level.
  819.  
  820.  
  821.  
  822.  
  823.                                     CONFIG FILE
  824.  
  825.  
  826.                 An example of a config file is shown here with
  827.        explanations.
  828.  
  829.  
  830.        C:\JMSTATS\
  831.        C:\WC30\ACTIVITY.009
  832.        C:\JMSTATS\DOWNLOAD.BBS
  833.        1200
  834.        2400
  835.        9600
  836.        14400
  837.  
  838.  
  839.  
  840.  
  841.        Xmodem
  842.        Xmodem/CRC
  843.        Xmodem/1KG
  844.        Ymodem
  845.        Ymodem/G
  846.        Zmodem
  847.        HS-Link
  848.        Moby-Turbo
  849.  
  850.  
  851.        50
  852.        150
  853.        C:\JMSTATS\SECURITY.BBS
  854.        C:\JMSTATS\FILENAME.BBS
  855.  
  856.                                       page 13
  857.  
  858.  
  859.  
  860.  
  861.                                       Jmstats
  862.  
  863.  
  864.        C:\JMSTATS\CALLER.BBS
  865.        C:\JMSTATS\DOORSTAT.BBS
  866.        C:\JMSTATS\TOPFILES.BBS
  867.        C:\JMSTATS\TIMEODAY.BBS
  868.        C:\JMSTATS\AREASTAT.BBS
  869.        --------------------------------------------------------------------
  870.        ------
  871.  
  872.        WARNING!!!!  All lines above this must be there or the program will
  873.        not run
  874.  
  875.        Definition of what the above configuration paramters mean:
  876.  
  877.        1...This is the path to where the data files are to be stored. By
  878.            having multiple configuration files with different directories
  879.            in this field, you can maintain separate databases for such
  880.            things as different nodes or different lengths of data
  881.            retention.
  882.  
  883.        2...This is the full path and filename of the ACTIVITY log that you
  884.            will be reading from. This is where WILDCAT! stores the
  885.            information this program reads it's information from.
  886.  
  887.        3...This is the full path and filename where the DOWNLOADS output
  888.            display will go. This could either be in the form of a bulletin
  889.            or Hello file or it could be a file stored somewhere else.
  890.            Leaving this line blank will force the output to go to the
  891.            screen, but with no pauses at this time. Putting PRN in this
  892.            line will send the output to the printer.
  893.  
  894.        4-11...These lines are the baud rates that will be displayed on the
  895.            download display. These must EXACTLY match the baud rates that
  896.            show up in your activity log. There are 8 lines for these and
  897.            they will appear in the exact order you enter them in this
  898.            configuration file.  Normal screen width would allow only 4
  899.            different baud rates. Of course, you may fill in more if you are
  900.            storing as a disk file that will not be used as a bulletin or
  901.            hello screen, or if you are sending the output to a printer that
  902.            can handle more than 80 characters per line. Leave all other
  903.            lines as balnk lines within these lines so the program will
  904.            truncate the display properly.
  905.  
  906.        12-21...These lines contain the file transfer protocols that will
  907.            appear in the download output. These must EXACTLY match the way
  908.            they appear in your activity log file. The output will take any
  909.            other downloads that do not match these and group them in a
  910.            protocol called 'OTHER PROTOCOLS' so that they will be included
  911.            in the display after the ones you have defined. The output will
  912.            contain these protocols in the exact order that you enter them.
  913.            In order to fit on a standard single screen, I would recommend
  914.            only putting in 5 protocols as it will add the OTHER PROTOCOLS
  915.            to the bottom of the display. Enter your most popular file
  916.            transfer protocols on these lines. Leave all other lines as
  917.            blank lines within these lines so the program will truncate the
  918.            display accordingly.
  919.  
  920.        22...This line contains the Minimum percentage of cps that you wish
  921.  
  922.                                       page 14
  923.  
  924.  
  925.  
  926.  
  927.                                       Jmstats
  928.  
  929.  
  930.            to include in the display and the average cps calculation. For
  931.            example, if you have this line set at 50, then a file transfer
  932.            for a 2400 baud caller would only be included if his cps was
  933.            greater than 120.  This will prevent those occasional file
  934.            transfers where the caller had a problem either on his end or
  935.            with the file and will not use these figures.
  936.  
  937.        23...This line contains the Maximum percentage of cps that you wish
  938.            to include in the display and the average cps calculation. For
  939.            example, if you have this line set at 150, then a file transfer
  940.            for a 2400 baud caller would only be included if his cps was
  941.            less than 360.  This will prevent those occasional file
  942.            transfers where the activity log shows some strange figure
  943.            because of recovery mode on a file transfer from showing up in
  944.            the display and affecting the average cps.
  945.  
  946.        24...This line is the full path and filename of the output file for
  947.            the Security level display. This can be PRN to output to the
  948.            printer, or left blank to output to the screen. Like the
  949.            download display, this can also be used as a bulletin or Hello
  950.            file.
  951.  
  952.        25...This line is the full path and filename of the output file for
  953.            the Filename display. This can be PRN to output to the printer,
  954.            or left blank to output to the screen. This option is not
  955.            intended to be used as a bulletin or hello file.
  956.  
  957.        26...This line is the full path and filename of the output file for
  958.            the caller display. This can be PRN to output to the printer, or
  959.            left blank to output to the screen. This option is not intended
  960.            to be used as a bulletin or hello file.
  961.  
  962.        27...This line is the full path and filename of the output file for
  963.            the Door statistics display. This can be PRN to output to the
  964.            printer, or left blank to output to the screen. This option can
  965.            be used as a bulletin or Hello screen.
  966.  
  967.        28...This line is the full path and filename for the output file for
  968.            the TOPFILES display. This can be PRN to output to the printer,
  969.            or left blank to output to the screen. This option can be used
  970.            as a bulletin or Hello screen.
  971.  
  972.        29...This line is the full path and filename for the output file for
  973.            the Time of Day display. This can be PRN to output to the
  974.            printer, or left blank to output to the screen. This option can
  975.            be used as a bulletin or Hello screen.
  976.  
  977.        30...This line is the full path and filename for the output file for
  978.            the file and message area statistics display. This can be PRN to
  979.            output to the printer, or left blank to output to the screen.
  980.            This option can be used as a bulletin or Hello screen.
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.                                       page 15
  989.  
  990.  
  991.